﻿/******************************************************************************
 * Copyright (c) 2011, S. Kyle Korndoerfer
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 *  * Redistributions of source code must retain the above copyright notice, 
 *      this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the 
 *      documentation and/or other materials provided with the distribution.
 *  * Neither the name of KyKo Software nor the names of its contributors may 
 *      be used to endorse or promote products derived from this software 
 *      without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE. 
 *****************************************************************************/

using System;
using System.Diagnostics.CodeAnalysis;

namespace WebSequenceDiagrams
{
    /// <summary>
    ///     Event Arguments for when the download from the service completes.
    /// </summary>
    public class DownloadCompleteEventArgs : EventArgs
    {
        /// <summary>
        ///     Instantiates a new instance of the class.
        /// </summary>
        /// <param name="pData">The data returned from the service.</param>
        /// <param name="pError">Any errors that were encountered while
        ///     retrieving the data from the service.</param>
        public DownloadCompleteEventArgs( byte[] pData, Exception pError )
        {
            Data = pData;
            Error = pError;
        }// DownloadCompleteEventArgs( pData, pErrors )

        #region Properties

        /// <summary>
        ///     The data downloaded from the service.
        /// </summary>
        [SuppressMessage( "Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays" )]
        public byte[] Data
        {
            get;
            
            private set;
        }// Data

        /// <summary>
        ///     Errors that were encountered when trying to download the
        ///     Image/PDF.
        /// </summary>
        public Exception Error
        {
            get;
            
            private set;
        }// Errors

        #endregion

    }// DownloadCompletedEventArgs
}
